Skip to content

Deprecate nadp module#243

Merged
thodson-usgs merged 1 commit intoDOI-USGS:mainfrom
thodson-usgs:deprecate-nadp
May 1, 2026
Merged

Deprecate nadp module#243
thodson-usgs merged 1 commit intoDOI-USGS:mainfrom
thodson-usgs:deprecate-nadp

Conversation

@thodson-usgs
Copy link
Copy Markdown
Collaborator

@thodson-usgs thodson-usgs commented May 1, 2026

Summary

  • Adds a DeprecationWarning to every public function in dataretrieval.nadp (get_annual_MDN_map, get_annual_NTN_map, get_zip).
  • The warning notes the scheduled removal date of 2026-11-01 (six months from this deprecation) and points users to retrieve NADP data directly from https://nadp.slh.wisc.edu/.
  • Adds a NEWS.md entry.

Tracking issue with full justification and timeline: #244.

Test plan

  • python3 -c "import dataretrieval.nadp; ..." confirms each of the three public functions raises DeprecationWarning with the expected message.
  • Existing tests/nadp_test.py should continue to pass (warnings are emitted but not errors); CI to confirm.

🤖 Generated with Claude Code

Each public function in `dataretrieval.nadp` (`get_annual_MDN_map`,
`get_annual_NTN_map`, `get_zip`) now emits a `DeprecationWarning` on
call, pointing users to retrieve NADP data directly from
https://nadp.slh.wisc.edu/. NADP is not a USGS service, and the
module has been lightly maintained (with several long-standing TODOs
that were never picked up); keeping it in `dataretrieval` is out of
scope for a USGS water-data package.

The module is scheduled for removal on or after 2026-11-01 (six
months after this deprecation lands), tracked in the linked issue.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@thodson-usgs thodson-usgs changed the title Deprecate nadp module ahead of 2026-11-01 removal Deprecate nadp module May 1, 2026
@thodson-usgs thodson-usgs merged commit 51ac674 into DOI-USGS:main May 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant